Skip to content

chore: comprehensive documentation cleanup for v0.2.1 #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
bbopen merged 1 commit into from
Jan 21, 2026
Merged

chore: comprehensive documentation cleanup for v0.2.1 #167

bbopen merged 1 commit into from
Jan 21, 2026

Conversation

@bbopen
Copy link
Owner

@bbopen bbopen commented Jan 21, 2026

Summary

Comprehensive documentation cleanup addressing issues identified during v0.2.1 release review.

Stale Documents Removed

  • Delete ROADMAP.md (all items completed via ADR-0001)
  • Removed untracked docs/adr/0001-unified-bridge-core.md locally
  • Removed untracked docs/tasks/unified-bridge-core.md locally

Pyodide Version Consistency (v0.24.1 → v0.28.0)

Aligns all Pyodide URLs with the >=0.28.0 peer dependency:

  • src/runtime/pyodide-io.ts - DEFAULT_INDEX_URL
  • README.md - browser example
  • docs/runtimes/browser.md - examples
  • docs/getting-started.md - example
  • docs/configuration.md - example
  • test/runtime_pyodide.test.ts - expectations
  • test/runtime_config.test.ts - expectations

CONTRIBUTING.md Fix

  • Fix Python version requirement: 3.12+ → 3.10+ (matches CI matrix which tests 3.10, 3.11, 3.12)

type-mapping-matrix.md Improvements

  • Remove false "automatically updated" claim
  • Fix year: 2024 → January 2026
  • Add Pydantic v2 BaseModel documentation
  • Fix torch.Tensor to show nested ndarray envelope structure

configuration.md Fix

  • Remove duplicate "Development Options" header (was at lines 258 and 269)

Test plan

  • npm run build && npm run typecheck passes
  • Pyodide-related tests pass: npx vitest run test/runtime_pyodide.test.ts test/runtime_config.test.ts
  • No remaining v0.24.1 references: grep -r "0.24.1" docs/ README.md src/ test/

🤖 Generated with Claude Code

@bbopen @claude
chore: comprehensive documentation cleanup for v0.2.1
2bf7db3 
## Stale Documents Removed
- Delete ROADMAP.md (all items completed via ADR-0001)
- Remove untracked docs/adr/0001-unified-bridge-core.md
- Remove untracked docs/tasks/unified-bridge-core.md

## Pyodide Version Consistency (v0.24.1 → v0.28.0)
- Update DEFAULT_INDEX_URL in src/runtime/pyodide-io.ts
- Update README.md browser example
- Update docs/runtimes/browser.md examples
- Update docs/getting-started.md example
- Update docs/configuration.md example
- Update test/runtime_pyodide.test.ts expectations
- Update test/runtime_config.test.ts expectations

This aligns all Pyodide URLs with the >=0.28.0 peer dependency.

## CONTRIBUTING.md Fix
- Fix Python version requirement: 3.12+ → 3.10+ (matches CI matrix)

## type-mapping-matrix.md Improvements
- Remove false "automatically updated" claim
- Fix year: 2024 → January 2026
- Add Pydantic v2 BaseModel documentation
- Fix torch.Tensor to show nested ndarray envelope structure

## configuration.md Fix
- Remove duplicate "Development Options" header

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2026

Warning

Rate limit exceeded

@bbopen has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b2071bf and 2bf7db3.

📒 Files selected for processing (10)
  • CONTRIBUTING.md
  • README.md
  • ROADMAP.md
  • docs/configuration.md
  • docs/getting-started.md
  • docs/runtimes/browser.md
  • docs/type-mapping-matrix.md
  • src/runtime/pyodide-io.ts
  • test/runtime_config.test.ts
  • test/runtime_pyodide.test.ts

Comment @coderabbitai help to get the list of available commands and usage tips.

bbopen
bbopen commented Jan 21, 2026
View reviewed changes
docs/type-mapping-matrix.md
Copy link
Owner Author

@bbopen bbopen Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO in future PR: automate generation of this file.

bbopen
bbopen commented Jan 21, 2026
View reviewed changes
Copy link
Owner Author

@bbopen bbopen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@bbopen bbopen merged commit 3668b5a into main Jan 21, 2026
19 of 20 checks passed
@bbopen bbopen deleted the chore/docs-cleanup-v021 branch January 21, 2026 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bbopen